/*
 * MIT License
 *
 * Copyright (c) 2023 北京凯特伟业科技有限公司
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.je.bpm.engine.impl.variable;

import com.je.bpm.engine.internal.Internal;

@Internal
public interface VariableType {

    /**
     * name of variable type (limited to 100 characters length)
     */
    String getTypeName();
    
    /**
     * <p>
     * Indicates if this variable type supports caching.
     * </p>
     * <p>
     * If caching is supported, the result of {@link #getValue(ValueFields)} is saved for the duration of the session and used for subsequent reads of the variable's value.
     * </p>
     * <p>
     * If caching is not supported, all reads of a variable's value require a fresh call to {@link #getValue(ValueFields)}.
     * </p>
     *
     * @return whether variables of this type are cacheable.
     */
    boolean isCachable();

    /**
     * @return whether this variable type can store the specified value.
     */
    boolean isAbleToStore(Object value);

    /**
     * Stores the specified value in the supplied {@link ValueFields}.
     */
    void setValue(Object value, ValueFields valueFields);

    /**
     * @return the value of a variable based on the specified {@link ValueFields}.
     */
    Object getValue(ValueFields valueFields);

}
